Allow using backticks to quote text in RDoc markup too#1551
Merged
Conversation
Users can now use both '`' and '+' to make simple code blocks in RDoc markup. Using backticks to quote code has become a natural habit for many users, so it's common to see it being incorrectly used to contribute to Ruby documentation. But instead of "correcting" users' behaviour, we should just support it. It'll also allow us to partially migrate some RDoc markup to Markdown.
Member
Author
|
cc @nobu |
Collaborator
|
🚀 Preview deployment available at: https://6c97bd4a.rdoc-6cd.pages.dev (commit: 5d254e8) |
nobu
approved these changes
Jan 7, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Users can now use both
`and+to make simple code blocks in RDoc markup.Using backticks to quote code has become a natural habit for many users, so it's common to see it being incorrectly used to contribute to Ruby documentation.
But instead of "correcting" users' behaviour, we should just support it. It'll also allow us to partially migrate some RDoc markup to Markdown.